home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 June / EnigmA AMIGA RUN 08 (1996)(G.R. Edizioni)(IT)[!][issue 1996-06][EARSAN CD VII].iso / earcd / comm2 / dlgmcs17.lha / EmacsDLG.DOC < prev    next >
Text File  |  1995-07-05  |  36KB  |  1,066 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                  EEEEE                      DDDD   L      GGG
  9.                  E                          D   D  L     G   G
  10.                  E     mmmmm  aaa cccc ssss D    D L     G
  11.                  EEEE  m m m    a c    s    D    D L     G GGG
  12.                  E     m m m aaaa c    ssss D    D L     G   G
  13.                  E     m m m a  a c       s D   D  L     G   G
  14.                  EEEEE m   m aaaa cccc ssss DDDD   LLLLL  GGGG
  15.  
  16.  
  17.              An Emacs-style Message Editor for DLG V1 by Alan Bland
  18.  
  19.                             Version 1.7 - July 1995
  20.  
  21.  
  22.  
  23.  
  24.  
  25.           1.  DISTRIBUTION RIGHTS
  26.  
  27.           EmacsDLG can be copied and distributed freely for any non-
  28.           commercial purposes.  Distributors of public domain software
  29.           collections may redistribute EmacsDLG for media costs only.
  30.  
  31.           Previous versions of EmacsDLG were shareware.  EmacsDLG is
  32.           now freeware.  All functions previously available only to
  33.           registered users are now available to all.  No keyfile is
  34.           necessary.  The following features were previously available
  35.           only to registered users but now are generally available:
  36.  
  37.              - EmacsFIG, a Gadtools-based program that lets you
  38.                customize many aspects of your EmacsDLG configuration:
  39.                colors, quote header, quote prefix, most text strings.
  40.                You will even be able to install multiple
  41.                configurations so you can run EmacsDLG in several
  42.                different languages!
  43.  
  44.              - Interfaces to use an AREXX spelling checker and any
  45.                compatible fortune cookie generator.
  46.  
  47.              - Individual customization per-user via the EmacsOpts
  48.                external program.
  49.  
  50.              - Full integration with the Hack & Slash messaging
  51.                system.
  52.  
  53.           For additional tips, see the Changes.TXT file included with
  54.           EmacsDLG.
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.            EmacsDLG 1.7                                       July 1995
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.                                      - 2 -
  76.  
  77.  
  78.  
  79.           2.  INSTALLATION
  80.  
  81.           To install EmacsDLG on your system for the first time,
  82.           perform the following steps:
  83.  
  84.             a.  Copy the EmacsDLG and EmacsFIG executables into your
  85.                 DLG: directory (or anywhere else you wish).
  86.  
  87.             b.  Copy the EmacsDLG.HLP and EmacsOpts files into your
  88.                 DLGconfig:Misc directory.
  89.  
  90.             c.  In the DLGconfig:Misc directory, run the EmacsFIG
  91.                 program.  Make any custom changes you wish, then SAVE
  92.                 the results.  The output of this program is a file
  93.                 called EmacsDLG.CFG, which by default must be stored
  94.                 in your DLGconfig:Misc directory.
  95.  
  96.             d.  Install the reqtools.library into your LIBS:
  97.                 directory.  You probably already have reqtools.library
  98.                 from some other utility that you use.  If you don't
  99.                 already have it, you should be able to obtain it from
  100.                 any Amiga BBS.  The reqtools.library is used for a
  101.                 file requester for local port file operations.  If you
  102.                 do not install reqtools.library, you will not be able
  103.                 to use the file requester.
  104.  
  105.             e.  Create an entry in your DLG Editor menu for EmacsDLG.
  106.                 In the description, you should mention that it is an
  107.                 Emacs-style editor and that it works for IBM ANSI and
  108.                 Amiga ANSI terminals.  Here are the settings to use.
  109.                 The flag settings are very important to the correct
  110.                 operation of EmacsDLG:
  111.  
  112.                      Name:  EMACS Full Screen Editor (ANSI IBM or Amiga)
  113.  
  114.                      Call string:  DLG:EmacsDLG ~b ~h ~r %uname %port
  115.  
  116.                      CTRL-c breaking:  No
  117.                      CTRL-d breaking:  Yes
  118.                      Return/linefeed:  Yes
  119.                                 Echo:  No
  120.                      Process killing:  Yes
  121.                         Kill pending:  No
  122.                       Pass-thru mode:  No
  123.                              Pausing:  No
  124.                             Raw mode:  Yes
  125.                             Timeouts:  Yes
  126.                        Verbose pause:  No
  127.                        Line freezing:  Yes
  128.  
  129.           That's all you need to do!  EmacsDLG is now ready to be used
  130.           by you and your callers!
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.           EmacsDLG 1.7                                       July 1995
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.                                      - 3 -
  147.  
  148.  
  149.  
  150.           2.1  FILE LOCATIONS
  151.  
  152.           After you have properly installed EmacsDLG, you will see the
  153.           following files.  If something does not work properly, check
  154.           to make sure the files are in their proper locations.
  155.  
  156.           _______________________________________________________
  157.           |File            Location                              |
  158.           |______________________________________________________|
  159.           | EmacsDLG       DLG: (or elsewhere if you wish)       |
  160.           | EmacsFIG       DLG: (or anywhere in your PATH)       |
  161.           | EmacsDLG.HLP   DLGconfig:misc                        |
  162.           | EmacsOpts      DLGconfig:misc                        |
  163.           | EmacsDLG.OPT   USER:User_Name (created by EmacsOpts) |
  164.           | EmacsDLG.CFG   DLGconfig:misc (created by EmacsFIG)  |
  165.           |______________________________________________________|
  166.           |______________________________________________________|
  167.  
  168.  
  169.  
  170.           2.2  UPGRADING FROM PREVIOUS VERSIONS
  171.  
  172.           If you already have a version of EmacsDLG installed, you
  173.           should make backup copies of the files and then copy the new
  174.           files over the old ones.
  175.  
  176.           Next, you need to upgrade your old EmacsDLG.CFG file from
  177.           the old format ot th enew format.  To perform the
  178.           conversion, simply execute the following commands:
  179.  
  180.                cd DLGconfig:misc   (or wherever you keep EmacsDLG.CFG)
  181.                run EmacsFIG
  182.                --> click on the SAVE gadget
  183.  
  184.           EmacsFIG will automatically convert the old format
  185.           configuration file to the new format.  If you fail to
  186.           perform this step, EmacsDLG will exit with an error message
  187.           when you try to run it.
  188.  
  189.  
  190.           2.3  MULTIPLE CONFIGURATIONS
  191.  
  192.           You may choose to install multiple EmacsDLG configurations.
  193.           The most likely reason would be to have different setups for
  194.           different languages, but you might also want to use
  195.           different spelling checkers or different fortune cookie
  196.           programs.
  197.  
  198.           To setup a second EmacsDLG configuration, perform the
  199.            following steps:
  200.  
  201.             a.  Create a directory, say "doors:EmacsToo".
  202.  
  203.             b.  Copy the EmacsDLG.HLP file into the directory, and use
  204.                 any text editor to edit it as desired.
  205.  
  206.  
  207.  
  208.  
  209.           EmacsDLG 1.7                                       July 1995
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.                                      - 4 -
  218.  
  219.  
  220.  
  221.             c.  Copy the EmacsOpts program into the directory.
  222.                 Otherwise the per-user customization command will not
  223.                 work.
  224.  
  225.             d.  Run EmacsFIG in this directory and save any desired
  226.                 changes.  NOTE: You must CD to this directory before
  227.                 running EmacsFIG!
  228.  
  229.             e.  Add a new editor entry, but use the following call
  230.                 string:
  231.  
  232.                      DLG:EmacsDLG ~b ~h ~r %uname %port doors:EmacsToo/
  233.  
  234.                 NOTE: The directory path MUST have a trailing slash or
  235.                 colon.
  236.  
  237.           EmacsDLG will look in the specified directory for its
  238.           configuration files instead of in the default
  239.           DLGconfig:Misc/.
  240.  
  241.  
  242.  
  243.  
  244.           3.  USER SETUP
  245.  
  246.           EmacsDLG has been extensively tested with Terminus 16-color
  247.           ANSI mode using an IBM font.  Any terminal package that
  248.           performs similar IBM ANSI emulations should perform just as
  249.           well.
  250.  
  251.           Several settings in the user's DLG Options menu affect how
  252.           EmacsDLG operates:
  253.  
  254.              - The ANSI Color setting determines whether EmacsDLG
  255.                displays color or monochrome.
  256.  
  257.              - EmacsDLG adapts to the users screen width and length.
  258.  
  259.              - The ANSI Screen Positioning setting determines whether
  260.                EmacsDLG uses the smart insert/delete character
  261.                operations.  If Screen Positioning is ON, EmacsDLG uses
  262.                those operations for fast screen updates.  If Screen
  263.                Positioning is OFF, EmacsDLG avoids those sequences,
  264.                allowing it to work great with most IBM terminal
  265.                 programs.
  266.  
  267.           Below is a list of recommended settings for several IBM
  268.           terminal programs that have a history of not working well
  269.           with DLG.  You will find EmacsDLG works very well when the
  270.           settings are correct.
  271.  
  272.              - QMODEM: Set QMODEM for ANSI emulation, Keypad emulation
  273.                ON, Numlock ON, and strict color ON.  Set DLG for ANSI
  274.                screen positioning OFF.
  275.  
  276.  
  277.  
  278.  
  279.  
  280.           EmacsDLG 1.7                                       July 1995
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.                                      - 5 -
  289.  
  290.  
  291.  
  292.              - PROCOMM:  Set PROCOMM for ANSI-BBS emulation.  Set DLG
  293.                for ANSI screen positioning OFF.
  294.  
  295.           Regular users of MicroEmacs, GNUemacs, MG2, EmacsXL, or
  296.           other variants of Emacs will feel quite at home with
  297.           EmacsDLG.  Many commands have been removed or restricted to
  298.           prevent users from accidentally or otherwise gaining access
  299.           to files on your system.  The supplied help file lists the
  300.           most common commands, but other popular Emacs commands also
  301.           work.
  302.  
  303.  
  304.  
  305.  
  306.           4.  SYSOP FILE OPERATIONS
  307.  
  308.           Several additional commands are available to users with
  309.           access level 255.  The access level is configurable using
  310.           EmacsFIG.  These commands are:
  311.  
  312.                ^X^I Insert-file
  313.  
  314.                     This command reads a text file from disk and
  315.                     inserts it into the message at the cursor.  If
  316.                     EmacsDLG is run from a local port (i.e. TL0) and
  317.                     the reqtools.library is installed, a file
  318.                     requester will pop up to let you choose the file
  319.                     using the mouse.  Otherwise EmacsDLG will prompt
  320.                     for the name of the file.  ^XI may also be used
  321.                     instead of ^X^I.
  322.  
  323.                     If ^X^I detects a non-ASCII file, it will
  324.                     automatically UUENCODE the file.  The UUENCODE
  325.                     algorithm is built in to EmacsDLG so no external
  326.                     program is necessary.
  327.  
  328.                     Your users can use ^X^I to insert a file from
  329.                     their private file directory.  A typical use would
  330.                     be to upload a file to themselves, then use ^X^I
  331.                      to mail it to another user.
  332.  
  333.                ^X^W Write-file
  334.  
  335.                     This command writes the contents of the message
  336.                     buffer into a disk file.  If EmacsDLG is run from
  337.                     a local port (i.e. TL0) and the reqtools.library
  338.                     is installed, a file requester will pop up to let
  339.                     you choose the file using the mouse.  Otherwise
  340.                     EmacsDLG will prompt for the name of the file.
  341.  
  342.                ^X^P Print-file
  343.  
  344.                     This command prints the message buffer to your
  345.                     PRT: device.  The same access permissions as ^X^W
  346.                     Write-file are used for ^X^P Print-file.
  347.  
  348.  
  349.  
  350.  
  351.           EmacsDLG 1.7                                       July 1995
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.                                      - 6 -
  360.  
  361.  
  362.  
  363.           5.  CUSTOMIZATION WITH EMACSFIG
  364.  
  365.           EmacsDLG works well "out of the box", but you may want to
  366.           customize various aspects of the program.  You can use the
  367.           EmacsFIG Gadtools-based configuration program.  EmacsFIG
  368.           will let you select colors, language text, quote headers,
  369.           and many more options.
  370.  
  371.           Since EmacsFIG uses GadTools as its user interface, you must
  372.           be running Workbench 2.0 or later to use it.  No support for
  373.           1.3 is planned.
  374.  
  375.           Run EmacsFIG in the directory you specified on the EmacsDLG
  376.           command line when you installed EmacsDLG.  EmacsFIG creates
  377.           a file named EmacsDLG.CFG that contains your customization
  378.           options.  Following are descriptions of each of the options
  379.           you may configure.
  380.  
  381.  
  382.           5.1  FILE READ ACCESS
  383.  
  384.           This defines the minimum access level for the ^X^I insert-
  385.           file command.  Any file on your system can be read using
  386.           this command, so it should be available only to you and
  387.           possibly your co-sysops.
  388.  
  389.  
  390.           5.2  FILE WRITE ACCESS
  391.  
  392.           This defines the minimum access level for the ^X^W write-
  393.           file command.  Any file on your system can be written using
  394.           this command, so it should be available only to you and
  395.           possibly your co-sysops.
  396.  
  397.  
  398.           5.3  TAB WIDTH
  399.  
  400.           When the user presses the TAB key, EmacsDLG inserts spaces
  401.           until the next tab position is reached.  By default, the tab
  402.           stops are set to every 8 positions.
  403.  
  404.  
  405.           5.4  FORTUNE COOKIE COMMAND
  406.  
  407.           A fortune cookie is a random comment, phrase, or joke that
  408.           can be inserted at the end of your message.  If enabled, the
  409.           fortune cookie will appear after your message text but
  410.           before your signature (if any).
  411.  
  412.           EmacsDLG allows up to twenty different fortune cookie
  413.           commands to be configured.  This lets your users choose
  414.           different themes depending on the message area they're
  415.           using, or on their mood.  For example, you could setup
  416.           fortunes for Star Trek, Movie Trivia, Famous Quotes, Dead
  417.           Baby Jokes, or whatever.
  418.  
  419.  
  420.  
  421.  
  422.           EmacsDLG 1.7                                       July 1995
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.                                      - 7 -
  431.  
  432.  
  433.  
  434.           Click the "New" gadget to create a new fortune cookie
  435.           command.  Enter the command and a brief description of the
  436.           command.  The description is what the users see when they
  437.           choose from multiple fortune commands, so say something like
  438.           "Star Trek quotes" as your description.
  439.  
  440.           Click the "Delete" gadget to delete the currently displayed
  441.           fortune cookie command, and click on "Next" to step through
  442.           all of the commands you have defined.
  443.  
  444.           To use fortune cookies, you must find a suitable fortune
  445.           cookie command and tell EmacsDLG how to run it.  The basic
  446.           requirement is that it must write its message to standard
  447.           output with no ANSI codes.  You should keep fortunes limited
  448.           to one or two lines to avoid the wrath of other sysops.
  449.  
  450.              - Mark Montminy's CRUMBS program is highly recommended.
  451.                It includes options to limit the chosen cookie to a
  452.                certain number of lines, and to provide leading and
  453.                trailing delimiters if you wish.  CRUMBS is available
  454.                from most BBS's that offer DLG support files.  LI
  455.                Here's a reasonable setup for CRUMBS that limits
  456.                fortunes to two lines, and puts three dots in front of
  457.                the fortune to make it stand out:
  458.  
  459.                     dlg:utils/crumbs -l 2 -p ...
  460.  
  461.              - Several databases of fortunes are floating around the
  462.                DLG community, included the typical cookies, Star Trek
  463.                 phrases, and obscene fortunes.  You may also choose to
  464.                create a database of your own fortunes, so that your
  465.                messages have a more individualized appearance.  Look
  466.                around various BBS's to find fortune cookie files.
  467.  
  468.           Enter the fortune cookie command in the appropriate gadget
  469.           in EmacsFIG.  Do not use any file redirection.  Do not use
  470.           "run" to execute the command.  The command should be found
  471.           in your CLI PATH, or you may specify the full path of the
  472.           command.
  473.  
  474.           The fortune cookie command line may contain any of the
  475.           normal DLG %variables.  These will be expanded and passed to
  476.           the fortune program, which may then do further processing.
  477.           This might be used by a combination fortune/signature
  478.           program to include the user's name in the generated fortune.
  479.           Note that this capability is meaningless if your fortune
  480.           cookie program does not use it.
  481.  
  482.           By default, the fortune cookie will NOT be added to
  483.           messages.  To get a cookie you must use the ESC-Z (user
  484.           customization) command from within EmacsDLG.  Any user who
  485.           wants to use the fortune cookies must do this.  They will
  486.           then have a choice of three fortune cookie options:
  487.  
  488.              - Never append a cookie to messages.  This is the
  489.                default.
  490.  
  491.  
  492.  
  493.           EmacsDLG 1.7                                       July 1995
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.                                      - 8 -
  502.  
  503.  
  504.  
  505.              - Ask if a cookie should be used when the message is
  506.                saved.  In this mode, the chosen cookie will appear in
  507.                the lower EmacsDLG window and you can choose whether or
  508.                not to use it.  If you don't like it, more cookies will
  509.                be chosen until you find one you like, or you give up.
  510.  
  511.              - Always append a cookie to messages.  In this mode,
  512.                EmacsDLG will choose a cookie and append it without
  513.                letting you preview the cookie.  This only works if you
  514.                have defined exactly one fortune cookie command.  If
  515.                you define more than one, EmacsDLG will always ask.
  516.  
  517.           The user also gets to decide which of the fortune cookie
  518.           topics is to be used as their default.  They can specify one
  519.           to use, or they can have EmacsDLG ask them each time they
  520.           save a message.
  521.  
  522.           Remember, to get a fortune cookie you must configure it in
  523.           the user customization command.
  524.  
  525.  
  526.  
  527.           5.5  FILE REQUESTER DIRECTORY
  528.  
  529.            The ^X^I insert-file and ^X^W write-file commands use a file
  530.           requester.  You may specify the directory path to be
  531.           displayed the first time the file requester is used.  The
  532.           default is RAM:.
  533.  
  534.  
  535.  
  536.           5.6  BROADCAST PORTS
  537.  
  538.           The ESC ! command can be used to send a broadcast message to
  539.           another port.  This is useful if you get a broadcast message
  540.           from another user, and you want to respond without leaving
  541.           the editor.  When ESC ! is invoked, EmacsDLG shows a listing
  542.           of who is on-line, so that you can direct your broadcast to
  543.           the correct port.  By default, the port listing will show
  544.           TR0, TR1, and TL0.
  545.  
  546.           Specify the ports you want displayed in the BROADCAST PORTS
  547.           gadget.  Type all your ports together as one string with no
  548.           blanks.  For example, "TR0TR1TR2TR3TR4".
  549.  
  550.  
  551.  
  552.           5.7  SPELLING CHECKER RUN COMMAND
  553.  
  554.           EmacsDLG uses an external AREXX spelling checker.  If you
  555.           wish EmacsDLG to start the spelling checker program when a
  556.           user first invokes it, specify that command here.  Note that
  557.           you will most likely want to use "RUN >NIL: command" so that
  558.           the spelling checker is run in the background.  The
  559.           redirection to NIL: is necessary to prevent AmigaDOS from
  560.           writing the "[CLI n]" message to the user's screen.
  561.  
  562.  
  563.  
  564.           EmacsDLG 1.7                                       July 1995
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.                                      - 9 -
  573.  
  574.  
  575.  
  576.           You may instead prefer to start the spelling checker in your
  577.           user-startup and leave it running all the time.  If you wish
  578.           to do this, enter a ";" semi-colon as the spelling checker
  579.           run command.
  580.  
  581.           See the SPELLING CHECKER section later in this manual for
  582.           details on how to configure specific spelling checkers.  The
  583.           default setup will work with Ispell.
  584.  
  585.  
  586.           5.8  SPELLING CHECKER AREXX PORT
  587.  
  588.           Enter the name of the AREXX port used by your spelling
  589.           checker.  The default setup will work with Ispell.
  590.  
  591.  
  592.           5.9  SPELLING CHECKER CHECK COMMAND
  593.  
  594.           Enter the AREXX command used by your spelling checker to
  595.            check a work.  The spelling checker must respond in one of
  596.           the following ways:
  597.  
  598.              - It should send a result code of 1, with a secondary
  599.                result of "ok" or "bad" depending on whether or not the
  600.                word is spelled correctly.
  601.  
  602.              - It should send a result code of 1 if the word is
  603.                spelled correctly, or a result code of 0 if the word is
  604.                spelled incorrectly.
  605.  
  606.  
  607.           5.10  SPELLING CHECKER EXIT COMMAND
  608.  
  609.           Enter the AREXX command that will cause your spelling
  610.           checker program to exit.  EmacsDLG will send this command
  611.           when the user exits from EmacsDLG.  The default setup works
  612.           with Ispell.
  613.  
  614.           You may prefer to leave your spelling checker running at all
  615.           times.  If you wish to do this, enter a ";" semi-colon as
  616.           the spelling checker exit command.
  617.  
  618.  
  619.           5.11  CUSTOM TEXT
  620.  
  621.           Many of the text messages displayed by EmacsDLG can be
  622.           customized.  The scrolling list contains a short description
  623.           of each text that can be changed.  Click on the desired
  624.           description to cause the current value to be displayed in
  625.           the large gadget below the list.  Then click on the large
  626.           gadget to change the text as desired.
  627.  
  628.           Most of the text strings are obvious.  Several need more
  629.           explanation, and are described below.
  630.  
  631.  
  632.  
  633.  
  634.  
  635.           EmacsDLG 1.7                                       July 1995
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.                                      - 10 -
  644.  
  645.  
  646.  
  647.           5.12  QUOTE GREETING TEXT
  648.  
  649.           The "Quote Greeting" is inserted at the top of a quoted
  650.           message.  Several special codes are used to allow you to
  651.           customize the contents of the quote greeting.  The permitted
  652.           codes are listed below.  Please note that the case of each
  653.           code IS important.
  654.  
  655.           Your users may create their own quote greetings using the
  656.           ESC-Z command.  Once a user has saved their settings with
  657.           ESC-Z, they get whatever quote greeting was in effect at the
  658.           time they saved it.  If you change it in EmacsFIG, those
  659.           users will not get the new quote greeting.
  660.  
  661.            The following codes may be used in the quote greeting:
  662.  
  663.               %F    The full name of the original message author
  664.                     (FROM).
  665.  
  666.               %f    The first name of the original message author.
  667.  
  668.               %T    The full name of the original message recipient
  669.                     (TO).
  670.  
  671.               %S    The subject or title of the quoted message.
  672.  
  673.               %q    The quote attribution of the original message
  674.                     author.  This will be either the initials or first
  675.                     name, depending on how you have configured the
  676.                     quote prefix in EmacsFIG.
  677.  
  678.               %d    The date and time that the quoted message was
  679.                     written.
  680.  
  681.               %N    A hard newline is inserted at this point.  You
  682.                     normally will want to end your quote greeting with
  683.                     a hard newline.
  684.  
  685.               %%    A single "%" is inserted at this point.
  686.  
  687.           Here are some useful examples:
  688.  
  689.                On %d %F wrote about %S:%N
  690.  
  691.                Dear %f,%N%NYou recently wrote the following message about
  692.                "%S" to %T:%N
  693.  
  694.                %F wrote the lines marked "%q" in the following quote:%N
  695.  
  696.  
  697.  
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.  
  705.  
  706.           EmacsDLG 1.7                                       July 1995
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.                                      - 11 -
  715.  
  716.  
  717.  
  718.           5.13  YES/NO TEXT
  719.  
  720.           The "Input yes" and "Input no" text defines what your user
  721.           will use to answer yes/no questions.  Specify the entire
  722.           word.  EmacsDLG will recognize the first character as the
  723.           value typed by the user.
  724.  
  725.  
  726.           5.14  COLORS
  727.  
  728.           Click on the gadget above the color pallete to choose which
  729.           color you want to configure, then select the color from the
  730.           pallete.  The preview window shows you what your users will
  731.           see using the standard IBM ANSI color pallete.  Depending on
  732.           the terminal program in use, the 8 brighter colors may show
  733.           up as bold text.
  734.  
  735.  
  736.           5.15  BORDER STYLE
  737.  
  738.           Click on the Border Style gadget to change the way the
  739.           border between Emacs windows is displayed.  Choices include
  740.           a reverse bar, ANSI single and double lines, and a variety
  741.           of ASCII characters.  Watch the preview window to see the
  742.           results.  The Reverse Bar and ASCII character selections an
  743.           be displayed on any terminal, while the The single and
  744.           double line selections require your users to use an IBM ANSI
  745.           character set.
  746.  
  747.  
  748.           5.16  QUOTE PREFIX
  749.  
  750.           One of the cycle gadgets lets you choose the style of quoted
  751.           lines.  You may select from the author's first name or
  752.           initials, and the initials may be either upper or lower
  753.           case.  You may also choose a simple ">" if you would rather
  754.           not clutter your quotes with names or initials.
  755.  
  756.  
  757.           5.17  SPECIAL OPTIONS
  758.  
  759.           The Special Options list allows special customization to be
  760.           done that is not specifically supported by EmacsFIG.
  761.           Normally you will not need to use this list.  Watch for
  762.           messages on the DLG support echos for special circumstances
  763.           where the Special Options may be necessary.
  764.  
  765.           There are ten entries in the Special Options list.  To add a
  766.           Special Option, click on one of the blank entries in the
  767.           list, then enter the value in the gadget below the list.  To
  768.           remove one, click on the entry in the list and then blank it
  769.           out in the gadget below the list.  Be very careful when
  770.           entering Special Options.  If you misspell an option, you
  771.           may cause EmacsDLG to malfunction.
  772.  
  773.  
  774.  
  775.  
  776.  
  777.           EmacsDLG 1.7                                       July 1995
  778.  
  779.  
  780.  
  781.  
  782.  
  783.  
  784.  
  785.                                      - 12 -
  786.  
  787.  
  788.  
  789.           5.18  SPECIAL WORD WRAP OPTION
  790.  
  791.           NOTE: This is available only in the ESC-Z per-user
  792.           customization command and cannot be set globally using
  793.            EmacsFIG.  Actually, there is a way using the SPECIAL
  794.           OPTIONS list, but there really should never be a need to set
  795.           this option globally.
  796.  
  797.           The special word wrap option causes EmacsDLG to
  798.           automatically turn word wrap OFF whenever it is invoked with
  799.           a normal file.  Messages and file descriptions will always
  800.           have word wrap on by default.
  801.  
  802.           The reason for this option is that some sysops like to use
  803.           EmacsDLG to remotely edit their configuration files.  Word
  804.           wrapping must be off when editing those files, else disaster
  805.           may ensue.  The only people likely to set this option are
  806.           those sysops and co-sysops who regularly edit configuration
  807.           files remotely.
  808.  
  809.           Note that when this option is set, word wrapping will be
  810.           turned off when creating a DLG bulletin and when adding a
  811.           comment to a file description.  DLG provides no way for
  812.           EmacsDLG to determine that these particular kinds of files
  813.           are being edited.  If you turn this option on, you will want
  814.           to use ^XMW to manually turn on word wrapping for those
  815.           kinds of files.
  816.  
  817.           The default behavior for EmacsDLG is to always have word
  818.           wrapping on.
  819.  
  820.  
  821.  
  822.  
  823.           6.  THE SPELLING CHECKER
  824.  
  825.           EmacsDLG uses AREXX to communicate with an external spelling
  826.           checker.  Any spelling checker that supports a compatible
  827.           AREXX interface will work.  EmacsDLG has been tested with
  828.           ISpell version 3.3LJR, and RXSpell, an AREXX spelling
  829.           checker used by Xenolink.  Both ISpell and RXSpell are
  830.           freely distributable.
  831.  
  832.           ISpell is available on many BBS's that provide DLG support
  833.           files.  It is available for FTP from Aminet sites, ususally
  834.           in the os2/util directory under the name ispell-3.3LJR.lzh,
  835.           and it is on the Aminet CD-ROM.
  836.  
  837.           Alternatively you can use RXSpell.  RXSpell is smaller and
  838.           faster than ISpell, but knows fewer words.
  839.  
  840.  
  841.  
  842.  
  843.  
  844.  
  845.  
  846.  
  847.  
  848.           EmacsDLG 1.7                                       July 1995
  849.  
  850.  
  851.  
  852.  
  853.  
  854.  
  855.  
  856.                                      - 13 -
  857.  
  858.  
  859.  
  860.           6.1  SETUP
  861.  
  862.           You can setup ISpell in either of two ways.  The first way
  863.           will simply cause misspelled words to be flagged, and allows
  864.           the user to enter a replacment.  Specify the following
  865.           options in EmacsFIG:
  866.  
  867.           _____________________________________
  868.           |Spell run     run >nil: c:ispell -r |
  869.           |AREXX port    IRexxSpell            |
  870.           |Spell check   quickcheck            |
  871.           |Spell exit    exit                  |
  872.           |____________________________________|
  873.  
  874.           The second way to use ISpell is to have it provide a list of
  875.           suggested replacements for any misspelled word.  The user
  876.           can then enter the correct word from the list of
  877.           suggestions, or supply their own word.  This is the
  878.           recommended setup.  Specify the following options in
  879.           EmacsFIG:
  880.  
  881.           _____________________________________
  882.           |Spell run     run >nil: c:ispell -r |
  883.           |AREXX port    IRexxSpell            |
  884.           |Spell check   check                 |
  885.           |Spell exit    exit                  |
  886.           |____________________________________|
  887.  
  888.           To use RXSpell, specify the following options in EmacsFIG:
  889.  
  890.           _______________________________________________________________
  891.           |Spell run     run >nil: doors:spell/rxspell doors:spell/dict. |
  892.           |AREXX port    SPELL                                           |
  893.           |Spell check   CHECKWORD                                       |
  894.           |Spell exit    QUIT                                            |
  895.           |______________________________________________________________|
  896.  
  897.           IMPORTANT INFORMATION:  When you configure the spelling
  898.           checker for the first time, you MUST use EmacsFIG and SAVE
  899.           the result.  Even if you use the default values shown in
  900.           EmacsFIG, those defaults will only take effect if you SAVE
  901.           them.
  902.  
  903.           My tests show that ISpell uses about 700K of RAM, while
  904.           RXSpell only uses 70K of RAM.  You may want to consider the
  905.           RAM requirements in choosing which spelling checker to use.
  906.  
  907.  
  908.           6.2  USING THE SPELLER
  909.  
  910.           To run the spelling checker on the current message, press
  911.           ESC-C.  EmacsDLG will interactively prompt for each
  912.           misspelled word, asking you for a replacement.  If you
  913.           choose to enter a replacement, the new word will be
  914.           substituted for the old one.
  915.  
  916.  
  917.  
  918.  
  919.           EmacsDLG 1.7                                       July 1995
  920.  
  921.  
  922.  
  923.  
  924.  
  925.  
  926.  
  927.                                      - 14 -
  928.  
  929.  
  930.  
  931.           If ISpell has been configured correctly, EmacsDLG will pop
  932.           up a window containing suggested replacments when a
  933.           misspelled word is found.
  934.  
  935.  
  936.  
  937.  
  938.           7.  HACK & SLASH MESSAGING INTEGRATION
  939.  
  940.           EmacsDLG can be invoked by Mark Montminy's Hack & Slash door
  941.           game to edit messages within the game.  EmacsDLG treats Hack
  942.           & Slash messages like regular messages.  The Hack & Slash
  943.           alias of the message recipient and subject will appear at
  944.           the top of the screen, and more importantly, the quote
  945.           commands work for quoting replies!
  946.  
  947.           Please contact me if you are the author of a door program
  948.           and would like to have EmacsDLG integrated with your door.
  949.  
  950.  
  951.  
  952.  
  953.           8.  TROUBLESHOOTING
  954.  
  955.           The most common problems with EmacsDLG are caused by
  956.           installing the files in the wrong places.  Please see the
  957.           INSTALLATION section for a list of file locations.  Note
  958.           that you may also specify a directory where all the EmacsDLG
  959.           files will live.  If you do it this way, all files go in
  960.           this directory, which simplifies installation and
  961.           troubleshooting.
  962.  
  963.           When running EmacsFIG, ALWAYS remember to CD to the
  964.           directory where your EmacsDLG.CFG file lives.  Otherwise it
  965.           will create a new one, and since the new one is in the wrong
  966.           directory, EmacsDLG won't find your settings.
  967.  
  968.           When upgrading to a new version of EmacsDLG, always run
  969.           EmacsFIG and SAVE the results.  This guarantees that your
  970.           EmacsDLG.CFG file is up to date with the latest version.
  971.  
  972.           If you get "Spelling checker not installed", you have either
  973.           misspelled the name of the AREXX port for the spelling
  974.           checker, or your EmacsDLG.CFG file is in the wrong
  975.           directory.
  976.  
  977.           If you get "No response from spelling checker", most likely
  978.           your spelling checker command string is incorrect.
  979.  
  980.           The spelling checker may return an error number.  If the
  981.           number is greater than zero, it is an AREXX error that you
  982.           can look up in your AREXX manual.  Negative numbers indicate
  983.           weird internal problems and should be reported to the
  984.           author.
  985.  
  986.  
  987.  
  988.  
  989.  
  990.           EmacsDLG 1.7                                       July 1995
  991.  
  992.  
  993.  
  994.  
  995.  
  996.  
  997.  
  998.                                      - 15 -
  999.  
  1000.  
  1001.  
  1002.           If you get an empty fortune, it's a bug in CRUMBS. :-)
  1003.  
  1004.           If a user has used the ESC-Z command to customize their
  1005.           editing environment, all of the customizable options are
  1006.           saved.  If you later make a global change using EmacsFIG,
  1007.           the change will be seen only by users who have not used
  1008.           ESC-Z.
  1009.  
  1010.           Here's the general sequence of activities when EmacsDLG
  1011.           starts up.  This may help you in figuring out why something
  1012.           is misbehaving.  You might try running SnoopDos is something
  1013.           is misbehaving.
  1014.  
  1015.             1.  Read the user's User.Data file.
  1016.  
  1017.             2.  Read the EmacsDLG.CFG file to get the sysop-customized
  1018.                 options.
  1019.  
  1020.             3.  Read the user's EmacsDLG.opt file to get user-
  1021.                 customized options.  All options specified here
  1022.                 override the sysop-customized options.
  1023.  
  1024.             4.  Read in the file to be edited, if any.
  1025.  
  1026.             5.  The first time a quote command is used, the quoted
  1027.                 message is read in and formatted.
  1028.  
  1029.             6.  The first time the user requests help, the
  1030.                 EmacsDLG.HLP file is loaded into memory.  Subsequent
  1031.                 help requests use the in-memory copy.
  1032.  
  1033.           The ESC-Z command works as follows:
  1034.  
  1035.             1.  Load the EmacsOpts program, passing to it the options
  1036.                 that are currently in effect.
  1037.  
  1038.             2.  If the user aborts their changes, EmacsOpts exits.
  1039.  
  1040.             3.  If the user save their changes, EmacsOpts writes the
  1041.                 EmacsDLG.OPT file in the user's home directory, and
  1042.                 then exits.
  1043.  
  1044.             4.  After EmacsOpts exits, EmacsDLG reads the EmacsDLG.OPT
  1045.                 file to make the new options take effect.  If a
  1046.                 message has already been quoted, the new quoting
  1047.                 options will not take effect until the next time
  1048.                 EmacsDLG is run.
  1049.  
  1050.  
  1051.  
  1052.  
  1053.  
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.  
  1061.           EmacsDLG 1.7                                       July 1995
  1062.  
  1063.  
  1064.  
  1065.  
  1066.